Return to doc.sitecore.com

Documentation

 

1.  Description

The Breadcrumb component forms a menu which shows the location of the current Sitecore Item in the content tree. The component also provides easy navigation from the current Item to any of its parent Items.  

The picture below shows an example of a breadcrumb:    

 

Please refer to the XSL section for more information about creating XSL renderings.

 

2.  Installation Guide

The XSL Breadcrumb rendering is distributed as a standard Sitecore package; hence in order to start using it, you should install the package. Please refer to the 'Installing Modules and Packages' article if you are not familiar with the standard Sitecore Packager too.

After the package installation, you will see the XSL breadcrumb rendering in the list of XSL renderings.

Thus you will be able to place it on a (sub)layout or tie via placeholder like any usual rendering.

 

3.  User Manual

The Breadcrumb is an XSL rendering, thus you can work with it like with any other XSL rendering.   

Open the Parameters tab of the rendering (double-click on the rendering) and set properties as described in the example below.   

 

You can also define the properties in the xslSimpleMenu rendering (see <!--parameter --> section in the rendering’s source code).  

 

Valid Attributes:

 

DividerClass

Property value:

The CSS class name for the divider.

Remarks:

The divider is text or image that is used for separating breadcrumb items.

 

DividerImage

Property value:

Name and path of image file.

Remarks:

The divider image is used for separating Items in the breadcrumb (it is inserted in between breadcrumb Items)

 

DividerStyle

Property value:

The CSS style for the divider

Remarks:

The divider is the text or image used for separating breadcrumb Items.

 

DividerText

Property value:

The text (or character) used for separating breadcrumb Items. Please notice that by default this property isn’t set.

 

TextClass

Property value:

The CSS class name for the breadcrumb Items' text.

 

TextField

Property value:

The name of the field that contains text to be displayed in breadcrumb Items. The default value is "Name".

 

TextStyle

Property value:

The CSS style for the breadcrumb Item text.

 

BreadcrumbClass

Property value:

The CSS class name for the breadcrumb (Each breadcrumb’s Item is placed in the div layer).

 

 

BreadcrumbStyle

Property value:

The style for the breadcrumb (Each breadcrumb’s Item is placed in the div layer).